fix(docs): correct stale hairpin-proxy uninstall claim and package names - #709
Conversation
❌ Deploy Preview for cozystack failed.
|
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
IvanHunters
left a comment
There was a problem hiding this comment.
LGTM. Both corrections are accurate against source, and the version coverage is complete.
On the package names in v1.0 and v1.1: the platform chart matches bundles.enabledPackages against the fully-qualified cozystack.<name> form. packages/core/platform/templates/_helpers.tpl does has $name $enabled, and $name is always the qualified name (templates/bundles/system.yaml passes cozystack.nfs-driver, templates/bundles/iaas.yaml sets $gpuName := "cozystack.gpu-operator"). So a bare nfs-driver or gpu-operator matches nothing and the package never gets enabled. The fix is right. v1.0 and v1.1 were the last two docs still carrying the bare name; v1.2 through v1.6 and next already use the qualified form, so nothing else needs touching.
The hairpin-proxy-protocol change (next, v1.4, v1.5, v1.6) is also correct. In fluxcd/helm-controller, reconcileDelete only runs the uninstall "if the resource has not been suspended" (if !obj.Spec.Suspend), and it removes the finalizer unconditionally. A HelmRelease that was suspended when it got deleted therefore goes away cleanly without an uninstall, and the pre-delete hook that runs as part of helm uninstall is skipped with it. The old text's "kubectl delete hr bypassing helm uninstall" had it backwards: an ordinary delete still runs uninstall through the finalizer. The page only exists in v1.4+ and next, and all of those are updated.
No blocking findings.
The tenant disable troubleshooting list named a manual kubectl delete of the HelmRelease object as a way to bypass helm uninstall and skip the chart's pre-delete hook. helm-controller runs the uninstall step (and the hook with it) for any HelmRelease deletion that is not suspended, so a bare object delete does not skip it. The case that actually skips the hook is a HelmRelease that was already suspended at the moment it got deleted, since the uninstall branch is conditioned on the resource not being suspended. Assisted-by: LLM Signed-off-by: Aleksei Sviridkin <f@lex.la>
The GPU and NFS driver guides told operators to add the bare component name (gpu-operator, nfs-driver) to bundles.enabledPackages. The platform chart's optional-package helper matches enabledPackages entries against the fully-qualified cozystack.<name> form, so the bare examples add a value the chart never checks and enable nothing. Later doc versions already carry the qualified form; this backports the same fix to v1.0 and v1.1. Assisted-by: LLM Signed-off-by: Aleksei Sviridkin <f@lex.la>
de6b2dd to
e30047a
Compare
Two docs corrections, both checked against source.
The tenant-disable troubleshooting list on the hairpin-proxy-protocol page had the failure case backwards. It named
kubectl delete hras a way to skiphelm uninstalland the chart's pre-delete hook. helm-controller runs the uninstall, and the hook with it, for every deleted HelmRelease that is not suspended. The case that really skips the hook is a HelmRelease that was already suspended when it got deleted. Fixed in next, v1.4, v1.5 and v1.6.The GPU operator and NFS driver guides on v1.0 and v1.1 add the bare name to
bundles.enabledPackages. The platform chart matches that list against the fullcozystack.<name>form, sogpu-operatorornfs-drivermatches nothing and the package is never enabled. v1.2 and later already use the qualified name.